Skip to content

Conversation

@erpeters157
Copy link
Contributor

@erpeters157 erpeters157 commented Nov 7, 2025

Add information about producing the must-gather image for IBM Fusion SAN troubleshooting.

Version(s):
4.20+

Issue:
CNV-68980

Link to docs preview:
Troubleshooting IBM Fusion Access for SAN

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Nov 7, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 7, 2025

@erpeters157: This pull request references CNV-68980 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.21.0" version, but no target version was set.

In response to this:

Add information about producing the must-gather image for IBM Fusion SAN troubleshooting.

Version(s):
4.20+

Issue:
CNV-68980

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 7, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Nov 7, 2025

If you encounter issues with {IBMFusionFirst}, provide the must-gather image with the other information provided to Red Hat support. This image contains critical data about your cluster and project resources, logs, and events from your deployment. The following command is used to create the image:

----
$ oc adm must-gather --image=icr.io/cpopen/ibm-spectrum-scale-must-gather:v5.2.3.1
Copy link

@achuzhoy achuzhoy Nov 7, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

v5.2.3.1 is a specific version
Do we want to replace it with something like:
oc adm must-gather --image=icr.io/cpopen/ibm-spectrum-scale-must-gather:v<CNSA version> ?

The CNSA version can be retrieved with:
oc get fusionaccesses.fusion.storage.openshift.io -n ibm-fusion-access fusionaccess-sample -o jsonpath='{.spec.storageScaleVersion}'

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@achuzhoy Thank you for the clarification. That is a great suggestion. I will implement the update.

@achuzhoy
Copy link

achuzhoy commented Nov 7, 2025

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 7, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 7, 2025

@erpeters157: This pull request references CNV-68980 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.21.0" version, but no target version was set.

In response to this:

Add information about producing the must-gather image for IBM Fusion SAN troubleshooting.

Version(s):
4.20+

Issue:
CNV-68980

Link to docs preview:
Troubleshooting IBM Fusion Access for SAN

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 7, 2025
@prabinovRedhat
Copy link

/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 9, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 10, 2025

@erpeters157: This pull request references CNV-68980 which is a valid jira issue.

Warning: The referenced jira issue has an invalid target version for the target branch this PR targets: expected the bug to target the "4.21.0" version, but no target version was set.

In response to this:

Add information about producing the must-gather image for IBM Fusion SAN troubleshooting.

Version(s):
4.20+

Issue:
CNV-68980

Link to docs preview:
Troubleshooting IBM Fusion Access for SAN

QE review:

  • QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

Copy link
Member

@ousleyp ousleyp left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few comments and suggestions. Please feel free to ping me if you have any questions. Thanks, Erin!

@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Nov 10, 2025
@openshift-ci
Copy link

openshift-ci bot commented Nov 10, 2025

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 10, 2025
@openshift-ci
Copy link

openshift-ci bot commented Nov 10, 2025

@erpeters157: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Copy link
Contributor

@abrennan89 abrennan89 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a few minor changes. Good work! 🙂

[id="troubleshoot-fusion-access-san_{context}"]
= Troubleshooting {IBMFusionFirst}

If you encounter issues with {IBMFusionFirst}, provide the must-gather image to Red{nbsp}Hat support. This image contains critical data about your cluster and project resources, logs, and events from your deployment.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you encounter issues with {IBMFusionFirst}, provide the must-gather image to Red{nbsp}Hat support. This image contains critical data about your cluster and project resources, logs, and events from your deployment.
[role="_abstract"]
If you encounter issues with {IBMFusionFirst}, provide the `must-gather` image to Red{nbsp}Hat support. This image contains critical data about your cluster and project resources, logs, and events from your deployment.

Per the CQA 2.0 guidelines, alll abstracts need this little tag :) ref: https://docs.google.com/spreadsheets/d/1wF_NUWXBJaYsaXp8Dn6TQOx9gD45NCqNxaPkXhYN-zI/edit?gid=503904153#gid=503904153


.Procedure

. To obtain the deployed version of {IBMFusionFirst}, use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. To obtain the deployed version of {IBMFusionFirst}, use the following command:
. To obtain the deployed version of {IBMFusionFirst}, run the following command:

Use "enter" or "run" per the OCP doc guidelines: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#procedure-step-that-introduces-a-command

This command returns the numeric value of the deployed version of {IBMFusionFirst} such as `2.11.0`.
====

. To create the must-gather image, use the following command:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
. To create the must-gather image, use the following command:
. To create the `must-gather` image, use the following command:

Funny enough, I went to check on this, and you can see in https://docs.redhat.com/en/documentation/openshift_container_platform/4.20/html/support/gathering-cluster-data#gathering-data-specific-features_gathering-cluster-data where it's formatted differently for Virtualization versus regular OCP 🤭

Image

I think it should be formatted as "must-gather image" but we probably need a follow up Jira to fix it in other places in the docs too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.20 branch/enterprise-4.21 CNV Label for all CNV PRs jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants